Типы

Service

class Service(enum.Enum)

Атрибуты:

  • taxi
  • drive
  • eats
  • tanker
  • cargo
  • travel
  • grocery

Role

class Role(enum.Enum)

Атрибуты:

  • department_manager
  • department_secretary
  • client_manager

Geo

class Geo(enum.Enum)

Атрибуты:

  • circle

PromocodeOrderService

class PromocodeOrderService(enum.Enum)

Атрибуты:

  • taxi
  • grocery
  • eats

SortingOrder

class SortingOrder(enum.Enum)

Атрибуты:

  • asc
  • desc

TimeRestrictionType

class TimeRestrictionType(enum.Enum)

Атрибуты:

  • weekly_date
  • range_date

Day

class Day(enum.Enum)

Атрибуты:

  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday

MeasureKind

class MeasureKind(enum.Enum)

Атрибуты:

  • money
  • volume

MeasurePeriod

class MeasurePeriod(enum.Enum)

Атрибуты:

  • day
  • week
  • month

ApproveRole

class ApproveRole(enum.Enum)

Атрибуты:

  • client
  • manager

GeoHotelPolicyType

class GeoHotelPolicyType(enum.Enum)

Атрибуты:

  • included
  • excluded

CountriesRestriction

class CountriesRestriction(enum.Enum)

Атрибуты:

  • rus
  • cis

TravelClass

class TravelClass(enum.Enum)

Атрибуты:

  • economy
  • business
  • premium
  • first

SortingField

class SortingField(enum.Enum)

Атрибуты:

  • due_date
  • finished_date

SortingDirection

class SortingDirection(enum.Enum)

Атрибуты:

  • asc
  • desc

TaxiOrderCancelRulesState

class TaxiOrderCancelRulesState(enum.Enum)

Атрибуты:

  • free
  • paid
  • minimal

OrdersCostTravelLimitPeriod

class OrdersCostTravelLimitPeriod(enum.Enum)

Атрибуты:

  • month
  • quarter
  • year

AccumulationPeriod

class AccumulationPeriod(enum.Enum)

Атрибуты:

  • week
  • month
  • quarter
  • last_month

EatsOrdersListRequest

class EatsOrdersListRequest

Атрибуты:

  • user_ids: List[str] — массив идентификаторов сотрудников, сделавших заказы.

Методы:

  • serialize — преобразует класс в JSON.

EatDiscountResponse

class EatDiscountResponse

Атрибуты:

  • sum: str — сумма без НДС.
  • vat: str — НДС.
  • with_vat: str — сумма с НДС.
  • sales_tax: Optional[str] — налог с продажи.
  • total: Optional[str] — итого.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

EatTransactionsTotalResponse

class EatTransactionsTotalResponse

Атрибуты:

  • sum: Optional[str] — сумма.
  • with_vat: Optional[str] — сумма с НДС.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

EatOrderModifierResponse

class EatOrderModifierResponse

Атрибуты:

  • name: str — название дополнения к блюду.
  • cost: str — стоимость без НДС. Возвращается только для завершенного заказа.
  • vat: str — НДС. Возвращается только для завершенного заказа.
  • cost_with_vat: str — стоимость с НДС. Возвращается только для завершенного заказа.
  • count: Optional[int] — количество.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

EatOrderCalculationResponse

class EatOrderCalculationResponse

Атрибуты:

  • name: str — название блюда.
  • cost: str — стоимость без НДС. Возвращается только для завершенного заказа.
  • vat: str — НДС. Возвращается только для завершенного заказа.
  • cost_with_vat: str — стоимость с НДС. Возвращается только для завершенного заказа.
  • modifiers: Optional[List[EatOrderModifierResponse]] — дополнения к блюду.
  • count: Optional[int] — количество.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

CostCenter

class CostCenter

Атрибуты:

  • id: str — идентификатор центра затрат.
  • title: str — название центра затрат.
  • value: str — значение.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

EatOrderItemResponse

class EatOrderItemResponse

Атрибуты:

  • id: str — идентификатор заказа.
  • user_id: str — идентификатор пользователя.
  • status: str — статус заказов.
  • created_at: str — дата и время создания заказа. Формат значения: YYYY-MM-DDThh:mm:ss±hh:mm
  • department_id: Optional[str] — идентификатор департамента.
  • closed_at: Optional[str] — дата и время завершения заказа. Формат значения: YYYY-MM-DDThh:mm:ss±hh:mm
  • restaurant_name: Optional[str] — название ресторана.
  • destination_address: Optional[str] — адрес доставки заказа.
  • order_calculation: Optional[List[EatOrderCalculationResponse]] — состав заказов.
  • final_cost: Optional[str] — стоимость без НДС. Ввозвращается только для завершенного заказа.
  • vat: Optional[str] — НДС. Возвращается только для завершенного заказа.
  • final_cost_with_vat: Optional[str] — стоимость с НДС. Возвращается только для завершенного заказа.
  • corp_discount: Optional[EatDiscountResponse] — корпоративная скидка.
  • corp_discount_reverted: Optional[bool] — отмена корпоративной скидки.
  • currency: Optional[str] — валюта.
  • eats_cost_centers: Optional[List[CostCenter]] — центры затрат для сервиса еды.
  • transactions_total: Optional[EatTransactionsTotalResponse] — итого транзакций.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

EatOrderListResponse

class EatOrderListResponse

Атрибуты:

  • orders: List[EatOrderItemResponse] — список заказов с описанием.
  • limit: Optional[int] — максимальное количество возвращаемых записей.
  • cursor: Optional[str] — отметка текущего запроса.
  • sorting_order: Optional[str] — направление сортировки массива заказов (по дате создания заказа).

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

SupportedRequirementSelectOptionResponse

class SupportedRequirementSelectOptionResponse

Атрибуты:

  • name: str — название опции (латинскими буквами).
  • label: str — название требования, к которому относится опция.
  • title: str — название опции.
  • weight: Optional[float] — вес.
  • max_count: Optional[int] — максимальное количество.
  • value: Optional[float] — объем.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

SupportedRequirementSelectResponse

class SupportedRequirementSelectResponse

Атрибуты:

  • type_select: str — тип значения.
  • option: List[SupportedRequirementSelectOptionResponse] — массив опций.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

SupportedRequirementItemResponse

class SupportedRequirementItemResponse

Атрибуты:

  • name: str — название требования (латинскими буквами).
  • label: str — название требования.
  • glued: Optional[bool] — склеенное требование.
  • type_requirement: Optional[str] — тип требования, возможные значения: select, boolean.
  • multiselect: Optional[bool] — доступность множественного выбора.
  • max_weight: Optional[float] — максимальный вес.
  • select: Optional[SupportedRequirementSelectResponse] — описание требования, указывается только для требований с типом select.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TariffClassItemResponse

class TariffClassItemResponse

Атрибуты:

  • name: str — название тарифа (латинскими буквами).
  • name_translate: str — название тарифа.
  • supported_requirements: List[SupportedRequirementItemResponse] — массив требований.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

ZoneInfoResponse

class ZoneInfoResponse

Атрибуты:

  • tariff_classes: List[TariffClassItemResponse] — массив тарифов.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

GeoCircle

class GeoCircle

Атрибуты:

  • center: List[float] — координаты центра.
  • radius: Union[int, float] — расстояние от центра (в метрах).

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseGeoRestrictions

class BaseGeoRestrictions

Атрибуты:

  • name: str — имя.
  • geo: GeoCircle — описание гео ограничения.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

GeoRestrictions

class GeoRestrictions

Атрибуты:

  • geo_type: Geo — тип гео ограничения, сейчас поддерживается только circle.

Методы:

  • serialize — преобразует класс в JSON.

GeoRestrictionsItemResponse

class GeoRestrictionsItemResponse

Атрибуты:

  • id: str — идентификатор.
  • geo_type: str — тип гео ограничения.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

GeoRestrictionsListResponse

class GeoRestrictionsListResponse

Атрибуты:

  • items: List[GeoRestrictionsItemResponse] — список гео ограничений.
  • limit: int — количество выводимых записей.
  • amount: int — общее количество записей.
  • offset: int — количество пропускаемых записей.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

GeoRestrictionsResponse

class GeoRestrictionsResponse

Атрибуты:

  • id: str — идентификационный номер района поездок.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

CodeUsageResponse

class CodeUsageResponse

Атрибуты:

  • used_at: str — использование кода.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

CodeItemResponse

class CodeItemResponse

Атрибуты:

  • id: str — идентификатор кода.
  • code: str — код.
  • status: str — статус кода.
  • usages: List[CodeUsageResponse] — использования.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

CodeListResponse

class CodeListResponse

Атрибуты:

  • codes: List[CodeItemResponse] — список кодов.
  • next_cursor: Optional[str] — отметка для следующего запроса.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BankName

class BankName

Атрибуты:

  • ru: str — название банка на русском языке.
  • en: str — название банка на английском языке.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

RawPromocodeGeoRestrictionsPointResponse

class RawPromocodeGeoRestrictionsPointResponse

Атрибуты:

  • corp_geo_id: str — идентификатор гео ограничений промокода.
  • name: str — название гео ограничения.
  • geo: GeoCircle — координаты области.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

RawPromocodeGeoRestrictionsResponse

class RawPromocodeGeoRestrictionsResponse

Атрибуты:

  • source: Optional[RawPromocodeGeoRestrictionsPointResponse] — гео ограничения точки отправления.
  • destination: Optional[RawPromocodeGeoRestrictionsPointResponse] — гео ограничения конечной точки.
  • max_intermediate_points: Optional[int] — максимальное количество промежуточных точек.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

PromocodeGeoRestrictionsPoint

class PromocodeGeoRestrictionsPoint

Атрибуты:

  • geo_restriction_id: str — идентификатор гео ограничения.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

PromocodeGeoRestrictions

class PromocodeGeoRestrictions

Атрибуты:

  • source: Optional[PromocodeGeoRestrictionsPoint] — гео ограничения точки отправления.
  • destination: Optional[PromocodeGeoRestrictionsPoint] — гео ограничения конечной точки.
  • max_intermediate_points: Optional[int] — максимальное количество промежуточных точек.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

PromocodeOrderPriceResponse

class PromocodeOrderPriceResponse

Атрибуты:

  • cost: str — стоимость без НДС.
  • cost_with_vat: str — стоимость с НДС.
  • vat: str — НДС.
  • currency: Optional[str] — валюта.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

PromocodeCreateResponse

class PromocodeCreateResponse

Атрибуты:

  • order_id: str — идентификатор заказа.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BasePromocodeOrder

class BasePromocodeOrder

Атрибуты:

  • value: int — номинал промокода.
  • count: int — количество.
  • active_until: str — срок действия.
  • bin_ranges: Optional[List[list]] — диапазон значений.
  • bank_name: Optional[BankName] — наименование банка.
  • classes: Optional[List[str]] — классы.

Методы:

  • serialize — преобразует класс в JSON.

Promocode

class Promocode(BasePromocodeOrder)

Атрибуты:

  • name: str — название промокода.
  • active_from: Optional[str] — начало действия промокода.
  • max_usages_count: Optional[int] — максимальное количество использований.
  • service: Optional[PromocodeOrderService] — сервис, в котором могут применяться промокоды.
  • geo_restrictions: Optional[List[PromocodeGeoRestrictions]] — гео ограничения.

Методы:

  • serialize — преобразует класс в JSON.

PromocodeOrderResponse

class PromocodeOrderResponse(BasePromocodeOrder)

Атрибуты:

  • order_id: str — идентификатор заказа.
  • status: str — статус.
  • pricing: PromocodeOrderPriceResponse — стоимость заказа.
  • service: str — сервис, в котором могут применяться промокоды.
  • geo_restrictions: Optional[List[RawPromocodeGeoRestrictionsResponse]] — массив гео ограничений.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

PromocodeOrderListResponse

class PromocodeOrderListResponse

Атрибуты:

  • orders: List[PromocodeOrderResponse] — массив заказов.
  • next_cursor: Optional[str] — курсор.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

PromocodeOrderCancelResponse

class PromocodeOrderCancelResponse

Атрибуты:

  • status: str — статус отмены заказа.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TankerOrderItemResponse

class TankerOrderItemResponse

Атрибуты:

  • id: str — идентификатор заказа.
  • user_id: str — идентификатор сотрудника.
  • client_id: str — идентификатор клиента.
  • created_at: str — дата создания заказа.
  • closed_at: Optional[str] — дата заверешения заказа.
  • fuel_type: Optional[str] — идентификатор топлива, например "a95_premium".
  • final_price: Optional[str] — итоговая стоимость, которую списали с клиента, с учетом скидок.
  • liters_filled: Optional[str] — фактический объем заправки. например, "7.07".
  • station_location: Optional[List[float]] — местоположение станции в формате [<долгота>, <широта].

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TankerOrdersResponse

class TankerOrdersResponse

Атрибуты:

  • orders: List[TankerOrderItemResponse] — массив заказов.
  • last_closed_at: Optional[str] — дата завершения последнего заказа из массива orders. Имеет формат YYYY-MM-DDThh:mm:ss.sss в UTC без таймзоны. Если массив пустой, last_closed_at не возвращается.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseManager

class BaseManager

Атрибуты:

  • yandex_login: str — логин менеджера.
  • email: Optional[str] — электронная почта менеджера.
  • fullname: Optional[str] — полное имя менеджера.
  • phone: Optional[str] — телефонный номер менеджера.
  • department_id: Optional[str] — идентификатор подразделения.

Методы:

  • serialize — преобразует класс в JSON.

Manager

class Manager(BaseManager)

Атрибуты:

  • role: Role — роль менеджера.

Методы:

  • serialize — преобразует класс в JSON.

ManagerItemResponse

class ManagerItemResponse(BaseManager)

Атрибуты:

  • id: str — идентификатор менеджера.
  • role: str — электронная почта менеджера.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

ManagersListResponse

class ManagersListResponse

Атрибуты:

  • items: List[ManagerItemResponse] — массив менеджеров.
  • limit: int — максимальное количество возвращаемых записей.
  • total_amount: int — количество найденных записей.
  • cursor: Optional[str] — отметка текущего запроса.
  • next_cursor: Optional[str] — отметка для следующего запроса. Для получения следующей страницы нужно передать значение из поля next_cursor в GET-параметр cursor. Если ответ пустой, поле next_cursor отсутствует.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

ManagerResponse

class ManagerResponse

Атрибуты:

  • id: str — идентификатор менеджера подразделения.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseLimit

class BaseLimit

Атрибуты:

  • limit_id: str — идентификатор лимита.
  • is_fleet_limit: Optional[bool] — ограничение по автопарку или нет.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

Limit

class Limit(BaseLimit)

Атрибуты:

  • service: Service — идентификатор сервиса, для которого задается лимит.

Методы:

  • serialize — преобразует класс в JSON.

LimitResponse

class LimitResponse(BaseLimit)

Атрибуты:

  • service: str — идентификатор сервиса, для которого задается лимит.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseUser

class BaseUser

Атрибуты:

  • fullname: str — полное имя сотрудника.
  • phone: str — телефонный номер сотрудника.
  • is_active: bool — признак активности сотрудника. Неактивный сотрудник не имеет возможности самостоятельного заказа и на его имя нельзя заказать поездку.
  • email: Optional[str] — электронная почта сотрудника.
  • cost_center: Optional[str] — название центра затрат клиента.
  • cost_centers_id: Optional[str] — идентификатор набора настроек центров затрат. Если не включать поле в запрос, сотруднику будет назначен основной центр затрат (при наличии у клиента новых типов центров затрат).
  • nickname: Optional[str] — краткое имя сотрудника.
  • department_id: Optional[str] — идентификатор подразделения.

Методы:

  • serialize — преобразует класс в JSON.

User

class User(BaseUser)

Атрибуты:

  • limits: Optional[List[Limit]] — информация о лимитах.

Методы:

  • serialize — преобразует класс в JSON.

UserGetResponse

class UserGetResponse(BaseUser)

Атрибуты:

  • id: str — идентификатор сотрудника.
  • is_deleted: bool — признак удаленности сотрудника (виден ли в интерфейсе), удаленный сотрудник не может быть активным.
  • client_id: Optional[str] — идентификатор клиента (кабинета).
  • limits: Optional[List[LimitResponse]] — информация о лимитах.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

UserCreateResponse

class UserCreateResponse

Атрибуты:

  • id: str — идентификатор сотрудника.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

UserUpdateResponse

class UserUpdateResponse

Атрибуты:

  • status: str — статус.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

UserListResponse

class UserListResponse

Атрибуты:

  • items: List[UserGetResponse] — массив сотрудников клиента.
  • limit: int — максимальное количество возвращаемых записей.
  • total_amount: int — количество найденных записей.
  • cursor: Optional[str] — отметка текущего запроса.
  • next_cursor: Optional[str] — отметка для следующего запроса. Для получения следующей страницы нужно передать значение из поля next_cursor в GET-параметр cursor. Если ответ пустой, поле next_cursor отсутствует.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

UsersSpendingListRequest

class UsersSpendingListRequest

Атрибуты:

  • user_ids: List[str] — массив с идентификаторами сотрудников (не более 100).

Методы:

  • serialize — преобразует класс в JSON.

LimitSpendingDetailsResponse

class LimitSpendingDetailsResponse

Атрибуты:

  • orders_cost: Optional[str] — ограничения лимита по тратам.
  • spent: Optional[str] — сумма, потраченная сотрудником по данному лимиту за текущий период.
  • orders_amount: Optional[int] — ограничение на количество поездок, которые сотрудник может совершить за период. Указывается только для сервиса taxi.
  • orders_spent: Optional[int] — количество совершенных заказов за текущий период.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

UserSpendingLimitItemResponse

class UserSpendingLimitItemResponse

Атрибуты:

  • limit_id: str — идентификатор лимита.
  • service: str — название сервиса лимита.
  • spending_details: LimitSpendingDetailsResponse — данные по тратам сотрудников.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

UserSpendingItemResponse

class UserSpendingItemResponse

Атрибуты:

  • user_id: str — идентификатор сотрудника.
  • limits: List[UserSpendingLimitItemResponse] — информация о лимитах.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

UsersSpendingListResponse

class UsersSpendingListResponse

Атрибуты:

  • users: List[UserSpendingItemResponse] — массив сотрудников.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseAccumulationRules

class BaseAccumulationRules

Атрибуты:

  • started_at: Optional[str] — начало действия.

Методы:

  • serialize — преобразует класс в JSON.

AccumulationRules

class AccumulationRules(BaseAccumulationRules)

Атрибуты:

  • accumulation_period: AccumulationPeriod — период накопления.

Методы:

  • serialize — преобразует класс в JSON.

AccumulationRulesResponse

class AccumulationRulesResponse(BaseAccumulationRules)

Атрибуты:

  • accumulation_period: str — период накопления.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

GeoRestriction

class GeoRestriction

Атрибуты:

  • source: Optional[str] — отправление.
  • destination: Optional[str] — назначение.
  • prohibiting_restriction: Optional[bool] — запрет ограничения.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseTimeRestriction

class BaseTimeRestriction

Атрибуты:

  • start_time: Optional[str] — начальное время ограничений.
  • end_time: Optional[str] — конечное время ограничений.
  • start_date: Optional[str] — начальная дата ограничений.
  • end_date: Optional[str] — конечная дата ограничений.

Методы:

  • serialize — преобразует класс в JSON.

TimeRestriction

class TimeRestriction(BaseTimeRestriction)

Атрибуты:

  • type_time_restriction: TimeRestrictionType — тип временных ограничений.
  • days: Optional[List[Day]] — список дней недели.

Методы:

  • serialize — преобразует класс в JSON.

TimeRestrictionResponse

class TimeRestrictionResponse(BaseTimeRestriction)

Атрибуты:

  • type_time_restriction: str — тип временных ограничений.
  • days: Optional[List[str]] — список дней недели.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

CounterResponse

class CounterResponse

Атрибуты:

  • users: int — количество ползователей.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseGeoHotelPolicy

class BaseGeoHotelPolicy

Атрибуты:

  • geo_id: int — идентификатор района.
  • name: str — наименование.
  • max_price_per_day: Optional[int] — максимальная цена за сутки.
  • min_price_per_day: Optional[int] — минимальная цена за сутки.

Методы:

  • serialize — преобразует класс в JSON.

GeoHotelPolicy

class GeoHotelPolicy(BaseGeoHotelPolicy)

Атрибуты:

  • type_geo_hotel_policy: GeoHotelPolicyType — тип.

Методы:

  • serialize — преобразует класс в JSON.

GeoHotelPolicyResponse

class GeoHotelPolicyResponse(BaseGeoHotelPolicy)

Атрибуты:

  • type_geo_hotel_policy: str — тип.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseHotelPolicy

class BaseHotelPolicy

Атрибуты:

  • stars: Optional[List[int]] — массив количества звезд.
  • max_price_per_day: Optional[int] — максимальная цена за сутки.
  • min_price_per_day: Optional[int] — минимальная цена за сутки.

Методы:

  • serialize — преобразует класс в JSON.

HotelPolicy

class HotelPolicy(BaseHotelPolicy)

Атрибуты:

  • geo: Optional[GeoHotelPolicy] — политика отеля.
  • weekly_restrictions: Optional[List[Day]] — ограничение по дня недели.

Методы:

  • serialize — преобразует класс в JSON.

HotelPolicyResponse

class HotelPolicyResponse(BaseHotelPolicy)

Атрибуты:

  • geo: Optional[GeoHotelPolicyResponse] — политика отеля.
  • weekly_restrictions: Optional[List[str]] — ограничение по дня недели.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseAviaPolicy

class BaseAviaPolicy

Атрибуты:

  • max_price: Optional[int] — максимальная цена.
  • min_price: Optional[int] — минимальная цена.
  • extra_baggage: Optional[bool] — потребуется ли дополнительный багаж.
  • aeroexpress: Optional[bool] — потребуется ли аэроэкспресс.

Методы:

  • serialize — преобразует класс в JSON

AviaPolicy

class AviaPolicy(BaseAviaPolicy)

Атрибуты:

  • countries_restrictions: Optional[List[CountriesRestriction]] — ограничения по странам.
  • classes: Optional[List[TravelClass]] — массив классов.

Методы:

  • serialize — преобразует класс в JSON.

AviaPolicyResponse

class AviaPolicyResponse(BaseAviaPolicy)

Атрибуты:

  • countries_restrictions: Optional[List[str]] — ограничения по странам.
  • classes: Optional[List[str]] — массив классов.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BudgetLimitRequest

class BudgetLimitRequest

Атрибуты:

  • title: str — название лимита.
  • service: Service — сервис, к которому относится лимит.
  • client_id: Optional[str] — идентификатор клиента (кабинета).
  • department_id: Optional[str] — идентификатор подразделения.

Методы:

  • serialize — преобразует класс в JSON.

BaseOrdersCostResponse

class BaseOrdersCostResponse

Атрибуты:

  • value: float — значение.
  • period: str — период.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrdersCostLimitResponse

class TaxiOrdersCostLimitResponse(BaseOrdersCostResponse)

Атрибуты:

  • accumulation_rules: Optional[AccumulationRulesResponse] — правила накопления.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

OrdersAmountTaxiLimit

class OrdersAmountTaxiLimit

Атрибуты:

  • value: float — значение.
  • period: MeasurePeriod — период.

Методы:

  • serialize — преобразует класс в JSON.

OrdersCostTaxiLimit

class OrdersCostTaxiLimit

Атрибуты:

  • value: float — значение.
  • period: MeasurePeriod — период.
  • accumulation_rules: Optional[AccumulationRules] — правила накопления.

Методы:

  • serialize — преобразует класс в JSON.

TaxiLimits

class TaxiLimits

Атрибуты:

  • orders_cost: Optional[OrdersCostTaxiLimit] — ограничение на сумму, которую клиент может потратить за период.
  • orders_amount: Optional[OrdersAmountTaxiLimit] — ограничение на число поездок, которые клиент может совершить за период.

Методы:

  • serialize — преобразует класс в JSON.

TaxiLimitsResponse

class c

Атрибуты:

  • orders_cost: Optional[TaxiOrdersCostLimitResponse] — ограничение на сумму, которую клиент может потратить за период.
  • orders_amount: Optional[BaseOrdersCostResponse] — ограничение на число поездок, которые клиент может совершить за период.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

EatOrdersCostLimitResponse

class EatOrdersCostLimitResponse(BaseOrdersCostResponse)

Атрибуты:

  • accumulation_rules: Optional[AccumulationRulesResponse] — правила накопления.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

OrdersCostEatsLimits

class OrdersCostEatsLimits

Атрибуты:

  • value: float — значение.
  • period: MeasurePeriod — период.
  • accumulation_rules: Optional[AccumulationRules] — правила накопления.

Методы:

  • serialize — преобразует класс в JSON.

EatsLimits

class EatsLimits

Атрибуты:

  • orders_cost: OrdersCostEatsLimits — ограничение на сумму, которую клиент может потратить за период.

Методы:

  • serialize — преобразует класс в JSON.

EatLimitsResponse

class EatLimitsResponse

Атрибуты:

  • orders_cost: Optional[EatOrdersCostLimitResponse] — ограничение на сумму, которую клиент может потратить за период.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

OrdersCostDriveLimits

class OrdersCostDriveLimits

Атрибуты:

  • value: float — значение.
  • period: MeasurePeriod — период.

Методы:

  • serialize — преобразует класс в JSON.

DriveLimits

class DriveLimits

Атрибуты:

  • orders_cost: OrdersCostDriveLimits — ограничение на сумму, которую клиент может потратить за период.

Методы:

  • serialize — преобразует класс в JSON.

DriveLimitsResponse

class DriveLimitsResponse

Атрибуты:

  • orders_cost: BaseOrdersCostResponse — ограничение на сумму, которую клиент может потратить за период.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TankerOrdersCostLimit

class TankerOrdersCostLimit(BaseOrdersCostResponse)

Атрибуты:

  • kind: Optional[str] — тип измерения.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TankerLimits

class TankerLimits

Атрибуты:

  • value: float — значение.
  • period: MeasurePeriod — период.
  • kind: Optional[MeasureKind] — тип измерения.

Методы:

  • serialize — преобразует класс в JSON.

TankerLimitsResponse

class TankerLimitsResponse

Атрибуты:

  • orders_cost: Optional[TankerOrdersCostLimit] — ограничение на сумму, которую клиент может потратить за период.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

OrdersCostAmountCargoLimit

class OrdersCostAmountCargoLimit

Атрибуты:

  • value: float — значение.
  • period: MeasurePeriod — период.

Методы:

  • serialize — преобразует класс в JSON.

CargoLimits

class CargoLimits

Атрибуты:

  • orders_cost: Optional[OrdersCostAmountCargoLimit] — ограничение на сумму, которую клиент может потратить за период.
  • orders_amount: Optional[OrdersCostAmountCargoLimit] — ограничение на число поездок, которые клиент может совершить за период.

Методы:

  • serialize — преобразует класс в JSON.

CargoLimitsResponse

class CargoLimitsResponse

Атрибуты:

  • orders_cost: Optional[BaseOrdersCostResponse] — ограничение на сумму, которую клиент может потратить за период.
  • orders_amount: Optional[BaseOrdersCostResponse] — ограничение на число поездок, которые клиент может совершить за период.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

OrdersCostTravelLimits

class OrdersCostTravelLimits

Атрибуты:

  • value: float — значение.
  • period: OrdersCostTravelLimitPeriod — период.

Методы:

  • serialize — преобразует класс в JSON.

TravelLimits

class TravelLimits

Атрибуты:

  • orders_cost: Optional[OrdersCostTravelLimits] — ограничение на сумму, которую клиент может потратить за период.

Методы:

  • serialize — преобразует класс в JSON.

TravelLimitsResponse

class TravelLimitsResponse

Атрибуты:

  • orders_cost: Optional[BaseOrdersCostResponse] — ограничение на сумму, которую клиент может потратить за период.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BudgetLimitTaxiRequest

class BudgetLimitTaxiRequest(BudgetLimitRequest)

Атрибуты:

  • categories: List[str] — список доступных тарифных категорий.
  • limits: TaxiLimits — лимиты.
  • enable_toll_roads: Optional[bool] — доступность платных дорог.
  • geo_restrictions: Optional[List[GeoRestriction]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.

Методы:

  • serialize — преобразует класс в JSON.

BudgetLimitEatsRequest

class BudgetLimitEatsRequest(BudgetLimitRequest)

Атрибуты:

  • limits: EatsLimits — лимиты.
  • is_qr_enabled: Optional[bool] — разрешена ли оплата по QR в вендоматах.
  • geo_restrictions: Optional[List[GeoRestriction]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.

Методы:

  • serialize — преобразует класс в JSON.

BudgetLimitTankerRequest

class BudgetLimitTankerRequest(BudgetLimitRequest)

Атрибуты:

  • limits: TankerLimits — лимиты.
  • fuel_types: Optional[List[str]] — список доступных видов топлива.
  • geo_restrictions: Optional[List[GeoRestriction]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.

Методы:

  • serialize — преобразует класс в JSON.

BudgetLimitDriveRequest

class BudgetLimitDriveRequest(BudgetLimitRequest)

Атрибуты:

  • limits: DriveLimits — лимиты.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.
  • cities: Optional[List[str]] — города.
  • tariffs: Optional[List[str]] — cписок доступных тарифов.
  • cars_classes: Optional[List[str]] — cписок доступных классов машин.
  • insurance_types: Optional[List[str]] — виды страхования.
  • enable_toll_roads: Optional[bool] — доступность платных дорог.

Методы:

  • serialize — преобразует класс в JSON

BudgetLimitGroceryRequest

class BudgetLimitGroceryRequest(BudgetLimitRequest)

Атрибуты:

  • limits: EatsLimits — лимиты.
  • geo_restrictions: Optional[List[GeoRestriction]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.

Методы:

  • serialize — преобразует класс в JSON.

BudgetLimitCargoRequest

class BudgetLimitCargoRequest(BudgetLimitRequest)

Атрибуты:

  • limits: CargoLimits — лимиты.
  • categories: List[str] — список доступных тарифных категорий.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BudgetLimitTravelRequest

class BudgetLimitTravelRequest(BudgetLimitRequest)

Атрибуты:

  • limits: TravelLimits — лимиты.
  • hotel_policy: Optional[HotelPolicy] — политика отеля.
  • avia_policy: Optional[AviaPolicy] — политика авиаперелетов.
  • allow_reservations_without_approve: Optional[bool] — доступность бронирования без подтверждения.
  • approve_role: Optional[ApproveRole] — подтверждающая роль.
  • approve_roles: Optional[List[ApproveRole]] — подтверждающие роли.

Методы:

  • serialize — преобразует класс в JSON.

BaseLimitResponse

class BaseLimitResponse

Атрибуты:

  • id: str — идентификатор лимита.
  • title: str — название лимита.
  • service: str — идентификатор сервиса, для которого задается лимит.
  • client_id: str — идентификатор клиента.
  • counters: CounterResponse — количество сотрудников с данным лимитом.
  • is_default: bool — признак, используется ли данный лимит по умолчанию (задан при активации сервиса клиенту).
  • can_edit: Optional[bool] — признак, может ли пользователь изменить или удалить данный лимит.
  • department_id: Optional[str] — идентификатор департамента, к которому относится лимит. Если департамент отсутствует, значит, это корневой департамент.

Методы:

  • serialize — преобразует класс в JSON.

TaxiLimitResponse

class TaxiLimitResponse(BaseLimitResponse)

Атрибуты:

  • limits: TaxiLimitsResponse — лимиты.
  • categories: List[str] — список доступных тарифных категорий.
  • geo_restrictions: Optional[List[GeoRestriction]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.
  • enable_toll_roads: Optional[bool] — доступность платных дорог.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

EatLimitResponse

class EatLimitResponse(BaseLimitResponse)

Атрибуты:

  • limits: EatLimitsResponse — лимиты.
  • geo_restrictions: Optional[List[GeoRestriction]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.
  • is_qr_enabled: Optional[bool] — разрешена ли оплата по QR в вендоматах.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

GroceryLimitResponse

class GroceryLimitResponse(BaseLimitResponse)

Атрибуты:

  • limits: EatLimitsResponse — лимиты.
  • geo_restrictions: Optional[List[GeoRestriction]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

DriveLimitResponse

class DriveLimitResponse(BaseLimitResponse)

Атрибуты:

  • limits: DriveLimitsResponse — лимиты.
  • cities: Optional[List[str]] — cписок доступных городов.
  • tariffs: Optional[List[str]] — cписок доступных тарифов.
  • cars_classes: Optional[List[str]] — список доступных классов машин.
  • insurance_types: Optional[List[str]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.
  • enable_toll_roads: Optional[bool] — доступность платных дорог.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TankerLimitResponse

class TankerLimitResponse(BaseLimitResponse)

Атрибуты:

  • limits: TankerLimitsResponse — лимиты.
  • geo_restrictions: Optional[List[GeoRestriction]] — информация о разрешенных районах поездок.
  • time_restrictions: Optional[List[TimeRestriction]] — ограничения по времени.
  • fuel_types: List[str] — cписок доступных видов топлива.
  • is_fleet_limit: Optional[bool] — ограничение по автопарку или нет.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

CargoLimitResponse

class CargoLimitResponse(BaseLimitResponse)

Атрибуты:

  • limits: CargoLimitsResponse — лимиты.
  • categories: List[str] — список доступных тарифных категорий.
  • is_fleet_limit: Optional[bool] — ограничение по автопарку или нет.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TravelLimitResponse

class TravelLimitResponse(BaseLimitResponse)

Атрибуты:

  • limits: TravelLimitsResponse — лимиты.
  • allow_reservations_without_approve: bool — доступность бронирования без подтверждения.
  • approve_role: str — подтверждающая роль.
  • approve_roles: List[str] — подтверждающие роли.
  • travel_policy_id: Optional[str] — идентификкатор политики путешествий.
  • hotel_policy: Optional[HotelPolicyResponse] — политика отеля.
  • avia_policy: Optional[AviaPolicyResponse] — политика авиаперелетов.
  • is_fleet_limit: Optional[bool] — ограничение по автопарку или нет.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BudgetLimitListResponse

class BudgetLimitListResponse

Атрибуты:

  • items: List[Union[TaxiLimitResponse, EatLimitResponse, GroceryLimitResponse, DriveLimitResponse, TankerLimitResponse, CargoLimitResponse, TravelLimitResponse]] — список лимитов.
  • limit: int — максимальное количество возвращаемых записей.
  • offset: int — количество пропущенных записей.
  • total_amount: int — количество найденных записей.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BudgetLimitUpdateResponse

class BudgetLimitUpdateResponse

Атрибуты:

  • id: str — идентификатор обновленного лимита.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

FieldSettingResponse

class FieldSettingResponse

Атрибуты:

  • title: str — название поля.
  • required: bool — обязательно ли заполнять это поле при заказе.
  • services: List[str] — идентификаторы сервисов, в которых можно использовать это поле при заказе.
  • format: str — идентификатор обновленного лимита.
  • values: List[str] — список кост-центров, доступных для сотрудника.
  • id: Optional[str] — идентификатор поля.
  • hidden: Optional[bool] — не показывать и не использовать это поле при заказе.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BudgetCostCenterItemResponse

class BudgetCostCenterItemResponse

Атрибуты:

  • id: Optional[str] — идентификатор центра затрат.
  • name: Optional[str] — название центра затрат.
  • default: Optional[bool] — признак, используется ли данный центр затрат по умолчанию (задан при активации сервиса клиенту).
  • field_settings: Optional[List[FieldSettingResponse]] — список настроек для каждого поля центров затрат.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BudgetCostCenterListResponse

class BudgetCostCenterListResponse

Атрибуты:

  • items: List[BudgetCostCenterItemResponse] — список центров затрат.
  • limit: int — максимальное количество возвращаемых записей.
  • offset: int — количество пропущенных записей.
  • total_amount: int — количество найденных записей.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

Department

class Department

Атрибуты:

  • name: str — название нового департамента.
  • parent_id: Optional[str] — идентификатор родительского подразделения, к которому мы хотим прикрепить новый департамент. Если в качестве parent_id передается null, то департамент прикрепляется к корневому подразделению.

Методы:

  • serialize — преобразует класс в JSON.

DepartmentCreateResponse

class DepartmentCreateResponse

Атрибуты:

  • id: str — идентификатор департамента.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

DepartmentBudget

class DepartmentBudget

Атрибуты:

  • budget: Optional[Union[float, int, Decimal]] — бюджет департамента.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

DepartmentBudgetResponse

class DepartmentBudgetResponse(DepartmentBudget)

Методы:

  • new — возвращает экземпляр класса.

DepartmentLimitsResponse

class DepartmentLimitsResponse

Атрибуты:

  • taxi: DepartmentBudgetResponse — бюджет департамента в сервисе такси.
  • eats: DepartmentBudgetResponse — бюджет департамента в сервисе еды.
  • tanker: DepartmentBudgetResponse — бюджет департамента в сервисе заправок.
  • cargo: DepartmentBudgetResponse — бюджет департамента в сервисе доставки.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

DepartmentItemResponse

class DepartmentItemResponse(Department)

Атрибуты:

  • id: str — идентификатор департамента.
  • limits: DepartmentLimitsResponse — ограничения по сервисам на сумму, которую пользователи департамента могут потратить суммарно.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

DepartmentListResponse

class DepartmentListResponse

Атрибуты:

  • items: List[DepartmentItemResponse] — список департаментов.
  • limit: int — максимальное количество возвращаемых записей.
  • offset: int — количество пропущенных записей.
  • total_amount: int — количество найденных записей.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

DepartmentUpdateRequest

class DepartmentUpdateRequest

Атрибуты:

  • name: Optional[str] — название департамента.
  • parent_id: Optional[str] — идентификатор родительского подразделения.

Методы:

  • serialize — преобразует класс в JSON.

DepartmentUpdateResponse

class DepartmentUpdateResponse

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

DepartmentDeleteResponse

class DepartmentDeleteResponse

Атрибуты:

  • deleted_ids: List[str] — список идентификаторов всех удаленных департаментов.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

RoutePointExtraData

class RoutePointExtraData

Атрибуты:

  • floor: Optional[str] — этаж.
  • apartment: Optional[str] — квартира.
  • comment: Optional[str] — комментарий.
  • contact_phone: Optional[str] — номер телефона.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

BaseRoutePoint

class BaseRoutePoint

Атрибуты:

  • fullname: Optional[str] — полное имя.
  • geopoint: Optional[List[Union[int, float, Decimal]]] — координаты.
  • porchnumber: Optional[str] — номер подъезда.
  • extra_data: Optional[RoutePointExtraData] — дополнительная информация.

Методы:

  • serialize — преобразует класс в JSON.

RoutePoint

class RoutePoint(BaseRoutePoint)

Атрибуты:

  • country: Optional[str] — страна.
  • locality: Optional[str] — населенный пункт.
  • premisenumber: Optional[str] — номер дома и корпуса.
  • thoroughfare: Optional[str] — название улицы или микрорайона (для адресов с нумерацией по микрорайону).

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

RoutePointResponse

class RoutePointResponse(BaseRoutePoint)

Атрибуты:

  • passed: Optional[bool] — пройдена точка маршрута или нет.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

Order

class Order

Атрибуты:

  • user_id: str — идентификатор сотрудника.
  • route: List[RoutePoint] — список координат точек маршрута.
  • class_tariff: str — тариф поездки.
  • due_date: Optional[str] — время, к которому нужно создать заказ. Формат значения: YYYY-MM-DDThh:mm:ss±hh:mm.
  • offer: Optional[str] — идентификатор оффера, полученного в запросе получения статистики по маршруту и информации о категориях обслуживания.
  • requirements: Optional[Dict[str, Union[bool, int, str]]] — дополнительные требования к заказу.
  • cost_center_values: Optional[List[CostCenter]] — новые поля центров затрат.
  • comment: Optional[str] — комментарий водителю.

Методы:

  • serialize — преобразует класс в JSON.

TaxiOrderTollRoadsResponse

class TaxiOrderTollRoadsResponse

Атрибуты:

  • user_chose_toll_road: Optional[bool] — пользователь выбрал платную дорогу.
  • user_had_choice: Optional[bool] — пользователь имел выбор (была бесплатная альтернатива).
  • auto_payment: Optional[bool] — оплата платной дороги за корпоративный счет.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderItemResponse

class TaxiOrderItemResponse

Атрибуты:

  • id: Optional[str] — идентификатор заказа.
  • user_id: Optional[str] — идентификатор пользователя.
  • status: Optional[str] — статус заказа.
  • class_tariff: Optional[str] — наименование тарифа.
  • source: Optional[RoutePointResponse] — начальная точка маршрута.
  • interim_destinations: Optional[List[RoutePointResponse]] — промежуточные точки маршрута.
  • destination: Optional[RoutePointResponse] — конечная точка маршрута.
  • cost_center_values: Optional[List[CostCenter]] — новые поля центров затрат.
  • due_date: Optional[str] — дата и время начала поездки. Формат значения: YYYY-MM-DDThh:mm:ss±hh:mm.
  • finished_date: Optional[str] — дата и время окончания поездки. Возвращается только для завершенного заказа. Формат значения: YYYY-MM-DDThh:mm:ss±hh:mm.
  • cost: Optional[Union[int, float, Decimal]] — стоимость поездки и проезда по платной дороге (если таковая была в заказе) без НДС. Возвращается только для завершенного заказа.
  • cost_with_vat: Optional[Union[int, float, Decimal]] — стоимость поездки и проезда по платной дороге (если таковая была в заказе) с НДС. Возвращается только для завершенного заказа.
  • toll_roads: Optional[TaxiOrderTollRoadsResponse] — платные дороги.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderListResponse

class TaxiOrderListResponse

Атрибуты:

  • items: List[TaxiOrderItemResponse] — список заказов клиента.
  • limit: int — максимальное количество возвращаемых записей.
  • offset: int — количество пропущенных записей.
  • total_amount: int — количество найденных записей.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderCancelRulesResponse

class TaxiOrderCancelRulesResponse

Атрибуты:

  • can_cancel: Optional[bool] — наличие или отсутствие возможности отмены заказа.
  • message: Optional[str] — текстовое описание правил отмены заказа.
  • state: Optional[str] — актуальный статус возможности отмены заказа.
  • title: Optional[str] — название правила отмены.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderPerformerVehicleResponse

class TaxiOrderPerformerVehicleResponse

Атрибуты:

  • model: Optional[str] — наименование модели автомобиля.
  • number: Optional[str] — номер автомобиля.
  • color: Optional[str] — цвет автомобиля.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderPerformerResponse

class TaxiOrderPerformerResponse

Атрибуты:

  • vehicle: Optional[TaxiOrderPerformerVehicleResponse] — информация об автомобиле.
  • fullname: Optional[str] — ФИО водителя.
  • phone: Optional[str] — номер телефона водителя.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderGetResponse

class TaxiOrderGetResponse(TaxiOrderItemResponse)

Атрибуты:

  • performer: Optional[TaxiOrderPerformerResponse] — информация об автомобиле и водителе.
  • cancel_rules: Optional[TaxiOrderCancelRulesResponse] — правила отмены заказа.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderCancelResponse

class TaxiOrderCancelResponse

Атрибуты:

  • status: str — статус заказа.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

OrderCreateResponse

class OrderCreateResponse

Атрибуты:

  • order_id: str — идентификатор заказа.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiActiveOrderItemResponse

class TaxiActiveOrderItemResponse

Атрибуты:

  • id: str — идентификатор заказа.
  • status: str — статус заказа.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiActiveOrderListResponse

class TaxiActiveOrderListResponse

Атрибуты:

  • items: List[TaxiActiveOrderItemResponse] — массив с данными о маршрутах.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

OrderRequest

class OrderRequest

Атрибуты:

  • route: List[List[Union[int, float, Decimal]]] — список координат точек маршрута.
  • due_date: Optional[str] — время, к которому нужно создать заказ. Формат значения: YYYY-MM-DDThh:mm:ss±hh:mm.
  • requirements: Optional[Dict[str, Union[bool, int, str]]] — дополнительные требования к заказу.
  • user_id: Optional[str] — идентификатор сотрудника.
  • use_toll_roads: Optional[bool] — использование платных дорог.

Методы:

  • serialize — преобразует класс в JSON.

TaxiOrderEstimatedWaitingResponse

class TaxiOrderEstimatedWaitingResponse

Атрибуты:

  • seconds: int — время ожидания в секундах.
  • message: str — время в текстовом формате.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderDetailsTariffItemResponse

class TaxiOrderDetailsTariffItemResponse

Атрибуты:

  • type_tariff: str — тип составляющей.
  • value: str — описание составляющей.
  • type_details: Optional[str] — детали о типе составляющей (например, название опции).

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderServiceLevelResponse

class TaxiOrderServiceLevelResponse

Атрибуты:

  • class_tariff: Optional[str] — категория тарифа.
  • is_fixed_price: Optional[bool] — признак фиксированной цены.
  • price: Optional[str] — ориентировочная стоимость поездки.
  • estimated_waiting: Optional[TaxiOrderEstimatedWaitingResponse] — предполагаемое ожидание.
  • details_tariff: Optional[List[TaxiOrderDetailsTariffItemResponse]] — описание составляющих минимального тарифа.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TollRoadsResponse

class TollRoadsResponse

Атрибуты:

  • has_tolls: bool — имеются ли платные участки.
  • auto_payment: bool — оплата платной дороги за корпоративный счет.
  • price: Optional[str] — стоимость платной дороги.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderRoutestatsGetResponse

class TaxiOrderRoutestatsGetResponse

Атрибуты:

  • offer: Optional[str] — идентификатор оффера.
  • service_levels: Optional[List[TaxiOrderServiceLevelResponse]] — список тарифов с их описанием.
  • toll_roads: Optional[TollRoadsResponse] — платные участки дороги.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

Feedback

class Feedback

Атрибуты:

  • rating: int — оценка выполнения заказа. Целое число от 1 до 5.
  • msg: Optional[str] — комментарий к выполненному заказу.

Методы:

  • serialize — преобразует класс в JSON.

TaxiFeedbackCreateResponse

class TaxiFeedbackCreateResponse

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderDestinationsUpdateRequest

class TaxiOrderDestinationsUpdateRequest

Атрибуты:

  • created_time: str — UTC-время создания изменения. Формат значений: YYYY-MM-DDThh:mm:ss±hh:mm.
  • destinations: List[RoutePoint] — точки измененного маршрута, кроме начальной точки.

Методы:

  • serialize — преобразует класс в JSON.

TaxiOrderDestinationsUpdateResponse

class TaxiOrderDestinationsUpdateResponse

Атрибуты:

  • changed_destinations: Optional[List[RoutePoint]] — измененный маршрут.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

VehicleInfoResponse

class VehicleInfoResponse

Атрибуты:

  • location: List[Union[int, float, Decimal]] — координаты положения автомобиля.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

TaxiOrderStatusGetResponse

class TaxiOrderStatusGetResponse

Атрибуты:

  • status: str — статус заказа.
  • vehicle: Optional[VehicleInfoResponse] — информация о местоположении автомобиля.
  • time_left_raw: Optional[Union[int, float, Decimal]] — время до прибытия водителя или до окончания заказа в секундах.

Методы:

  • serialize — преобразует класс в JSON.
  • new — возвращает экземпляр класса.

OrdersCancelRequest

class OrdersCancelRequest

Атрибуты:

  • state: TaxiOrderCancelRulesState — актуальный статус возможности отмены. Возможные значения: free, paid, minimal. Статус можно получить из запроса Информация о заказе.

Методы:

  • serialize — преобразует класс в JSON.
Предыдущая
UserManager
Следующая
Ошибки